home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1992 June: ROMin Holiday / ADC Developer CD (1992-06) (''ROMin Holiday'')_iso / Developer Connection - 06-1992.iso / Developer Essentials / MPW Interfaces & Libraries / AIncludes / Editions.a < prev    next >
Encoding:
Text File  |  1992-01-29  |  11.3 KB  |  487 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:            Editions.a
  3. ;
  4. ;    Contains:        Assembly Interface for Edition Manager 
  5. ;
  6. ;    Copyright:        © 1990-1991 by Apple Computer, Inc., all rights reserved.
  7. ;
  8. ;--------------------------------------------------------------------
  9.  
  10.  
  11.  
  12.     IF &TYPE('__IncludingEditions__') = 'UNDEFINED' THEN
  13. __IncludingEditions__    SET    1
  14.  
  15.     IF &TYPE('__IncludingTraps__') = 'UNDEFINED' THEN       ; get defintion of _PACK11
  16.     INCLUDE 'Traps.a'
  17.     ENDIF
  18.  
  19.     IF &TYPE('__IncludingFSEqu__') = 'UNDEFINED' THEN        ; get definition of FSSpec
  20.     INCLUDE     'FSEqu.a'
  21.     ENDIF
  22.  
  23.  
  24. ; resource types 
  25. rSectionType                EQU     'sect'
  26.  
  27. ; section types 
  28. stSubscriber                EQU     $01
  29. stPublisher                 EQU     $0A
  30.  
  31. ; Update Modes 
  32. sumAutomatic                EQU        0    ; subscriber update mode - Automatically 
  33. sumManual                    EQU        1    ; subscriber update mode - Manually 
  34. pumOnSave                    EQU        0    ; publisher update mode - On Save 
  35. pumManual                    EQU        1    ; publisher update mode - Manually 
  36.     
  37. ; EditionContainer subpart usage 
  38. kPartsNotUsed                EQU         0
  39. kPartNumberUnknown            EQU        -1
  40.  
  41. ; preview size 
  42. kPreviewWidth                EQU        120
  43. kPreviewHeight                EQU        120
  44.  
  45. ; special formats 
  46. kPublisherDocAliasFormat    EQU        'alis'     ; same as rAliasType
  47. kPreviewFormat                EQU        'prvw'
  48. kFormatListFormat            EQU        'fmts'
  49.  
  50. ; bits for formatsMask 
  51. kPICTformatMask                EQU        1
  52. kTEXTformatMask                EQU        2
  53. ksndFormatMask                EQU        4
  54.  
  55. ; Finder types for edition files 
  56. kPICTEditionFileType        EQU        'edtp'
  57. kTEXTEditionFileType        EQU        'edtt'
  58. ksndEditionFileType            EQU        'edts'
  59. kUnknownEditionFileType        EQU        'edtu'
  60.  
  61. ; pseudo-item hits for dialogHooks 
  62. ; the first is for NewPublisher or NewSubscriber Dialogs 
  63. emHookRedrawPreview            EQU     150
  64. ; the following are for SectionOptions Dialog 
  65. emHookCancelSection            EQU        160    
  66. emHookGoToPublisher            EQU        161
  67. emHookGetEditionNow            EQU        162
  68. emHookSendEditionNow        EQU        162
  69. emHookManualUpdateMode        EQU        163
  70. emHookAutoUpdateMode        EQU        164
  71.  
  72.  
  73. ; the refcon field of the dialog record in a modalfilter or 
  74. ; dialoghook during SectionOptionsDialog contains one the following 
  75. emOptionsDialogRefCon        EQU        'optn'
  76. emCancelSectionDialogRefCon    EQU        'cncl'
  77. emGoToPubErrDialogRefCon    EQU        'gerr'
  78.  
  79.  
  80. ; misc 
  81. kFormatLengthUnknown        EQU        -1
  82.  
  83.  
  84. ; record definitions
  85. ;
  86. SectionRecord    RECORD    0
  87. version            DS.B    1    ;    SignedByte         { always 1 in 7.0 release }
  88. kind            DS.B    1    ;    SectionType        { publisher or subscriber }
  89. mode            DS.W    1    ;    UpdateMode         { auto or manual }
  90. mdDate             DS.L    1    ;    TimeStamp        { version of data in section }
  91. sectionID        DS.L    1    ;    LONGINT            { application specific, unique per document }
  92. refCon             DS.L    1    ;    LONGINT            { application specific }
  93. alias            DS.L    1    ;    AliasHandle        { handle to Alias Record }
  94. ; the following fields are private and set up by RegisterSection 
  95. subPart            DS.L    1    ;    LONGINT            { which part of container,  always kPartsNotUsed in 7.0 }
  96. nextSection        DS.L    1    ;    SectionHandle    { for linked list of app's Sections }
  97. controlBlock    DS.L    1    ;    Handle            { shared controlblock for this section. }
  98. refNum             DS.L    1    ;    EditionRefNum    { NIL outside of Open/CloseEdition }
  99. size            EQU        *
  100.                 ENDR
  101.  
  102.  
  103. EditionContainerSpec RECORD 0
  104. theFile                DS        FSSpec                ;
  105. theFileScript        DS.W    1                    ;    ScriptCode
  106. thePart                DS.L    1                    ;    LONGINT
  107. thePartName            DS.B    32                    ;    Str31
  108. thePartScript        DS.W    1                    ;    ScriptCode
  109. size                EQU        *
  110.                     ENDR        
  111.  
  112.  
  113. EditionInfoRecord    RECORD 0
  114. crDate                DS.L    1                     ;     Timestamp        { date EditionContainer was created }
  115. mdDate                DS.L    1                     ;     Timestamp        { date of last change }
  116. fdCreator            DS.B    4                     ;     OSType            { file creator }
  117. fdType                DS.B    4                     ;     OSType         { file type, 'edtT', etc }
  118. container            DS        EditionContainerSpec ;                    { the Edition }
  119. size                EQU        *
  120.                     ENDR
  121.  
  122. NewPublisherReply    RECORD 0
  123. canceled            DS.B    1                     ;    BOOLEAN            { O }
  124. replacing            DS.B    1                     ;    BOOLEAN            { O }    
  125. usePart                DS.B    1                     ;    BOOLEAN            { I }
  126. pad1                DS.B    1                     ;    
  127. preview                DS.L    1                     ;    Handle             { I }
  128. previewFormat        DS.B    4                     ;    FormatType         { I }
  129. container            DS        EditionContainerSpec ;                    { I/O }
  130. size                EQU        *
  131.                     ENDR
  132.  
  133. NewSubscriberReply    RECORD 0
  134. canceled            DS.B    1                     ;    BOOLEAN            { O }
  135. formatsMask            DS.B    1                     ;    SignedByte        { I }
  136. container            DS        EditionContainerSpec ;                    { I/O }
  137. size                EQU        *
  138.                     ENDR
  139.  
  140. SectionOptionsReply RECORD 0
  141. canceled            DS.B    1                    ;    BOOLEAN            { O }
  142. changed                DS.B    1                    ;    BOOLEAN            { O }
  143. sectionH            DS.L    1                    ;    SectionHandle    { I }
  144. action                DS.B    4                    ;     ResType            { 0 }
  145. size                EQU        *
  146.                     ENDR
  147.  
  148.  
  149. ; FormatIOVerb's
  150. ioHasFormat            EQU        0
  151. ioReadFormat        EQU        1
  152. ioNewFormat            EQU        2
  153. ioWriteFormat        EQU        3
  154.  
  155. FormatIOParamBlock    RECORD 0
  156. ioRefNum            DS.L    1                    ;    LONGINT
  157. format                DS.B    4                    ;     FormatType
  158. formatIndex            DS.L    1                    ;    LONGINT
  159. offset                DS.L    1                    ;     LONGINT
  160. buffPtr                DS.L    1                    ;    Ptr
  161. buffLen                DS.L    1                    ;    LONGINT
  162. size                EQU        *
  163.                     ENDR
  164.  
  165.  
  166. ; EditionOpenerVerb's
  167. eoOpen                EQU        0
  168. eoClose                EQU        1
  169. eoOpenNew            EQU        2
  170. eoCloseNew            EQU        3
  171. eoCanSubscribe        EQU        4
  172.  
  173. EditionOpenerParamBlock RECORD 0
  174. info                DS        EditionInfoRecord    ;
  175. sectionH            DS.L    1                    ;    SectionHandle
  176. document            DS.L    1                    ;    FSSpecPtr
  177. fdCreator            DS.B    4                    ;    OSType
  178. ioRefNum            DS.L    1                    ;    LONGINT
  179. ioProc                DS.L    1                    ;     FormatIOProcPtr
  180. success                DS.B    1                    ;    BOOLEAN
  181. formatsMask            DS.B    1                    ;    SignedByte    
  182. size                EQU        *
  183.                         ENDR
  184.  
  185.  
  186. ; Section Events
  187. sectionEventMsgClass    EQU     'sect'
  188. sectionReadMsgID        EQU     'read'
  189. sectionWriteMsgID        EQU     'writ'
  190. sectionScrollMsgID        EQU     'scrl'
  191. sectionCancelMsgID        EQU     'cncl'
  192.     
  193. ; 
  194. ;    Section events now arrive in the message buffer using the AppleEvent format.
  195. ;    The direct object parameter is an aeTemporaryIDParamType ('tid '). The temporary
  196. ;    ID's type is rSectionType ('sect') and the 32-bit value is a SectionHandle.
  197. ;    The following is a sample buffer
  198. ;    
  199. ;    name            offset    contents
  200. ;    ----            ------    --------
  201. ;    
  202. ;    header            0        'aevt'
  203. ;    majorVersion    4        $01
  204. ;    minorVersion    6        $01
  205. ;    endOfMetaData    8        ';;;;' 
  206. ;    directObjKey    12        '----' 
  207. ;    paramType        16        'tid ' 
  208. ;    paramLength        20        $0008 
  209. ;    tempIDType        24        'sect' 
  210. ;    tempID             28        the SectionHandle <-- this is want you want
  211. ;
  212.  
  213.     
  214. ;    FUNCTION InitEditionPack: OSErr;
  215.         MACRO
  216.         _InitEditionPack
  217.         MOVE.W     #$0011,-(SP)
  218.         MOVE.W     #$0100,D0
  219.         _Pack11
  220.         ENDM
  221.  
  222.  
  223. ;    FUNCTION NewSection(container: EditionContainerSpec;
  224. ;                        sectionDocument: FSSpecPtr; 
  225. ;                        kind: SectionType;
  226. ;                        sectionID: LONGINT;
  227. ;                        initalMode: UpdateMode; 
  228. ;                        VAR sectionH: SectionHandle): OSErr;
  229.         MACRO
  230.         _NewSection
  231.         MOVE.W     #$0A02,D0
  232.         _Pack11
  233.         ENDM
  234.  
  235.     
  236. ;    FUNCTION RegisterSection(sectionDocument: FSSpec; sectionH: SectionHandle;
  237. ;                            VAR aliasWasUpdated: BOOLEAN): OSErr;
  238.         MACRO
  239.         _RegisterSection
  240.         MOVE.W     #$0604,D0
  241.         _Pack11
  242.         ENDM
  243.  
  244.     
  245.  
  246. ;    FUNCTION UnRegisterSection(sectionH: SectionHandle): OSErr;
  247.         MACRO
  248.         _UnRegisterSection
  249.         MOVE.W     #$0206,D0
  250.         _Pack11
  251.         ENDM
  252.  
  253.  
  254.  
  255. ;    FUNCTION IsRegisteredSection(sectionH: SectionHandle): OSErr;
  256.         MACRO
  257.         _IsRegisteredSection
  258.         MOVE.W     #$0208,D0
  259.         _Pack11
  260.         ENDM
  261.  
  262.  
  263.     
  264. ;    FUNCTION AssociateSection(sectionH: SectionHandle; newSectionDocument: FSSpecPtr): OSErr;
  265.         MACRO
  266.         _AssociateSection
  267.         MOVE.W     #$040C,D0
  268.         _Pack11
  269.         ENDM
  270.  
  271.     
  272. ;    FUNCTION CreateEditionContainerFile(editionFile: FSSpec; fdCreator: OSType;
  273. ;                                        editionFileNameScript: ScriptCode): OSErr;
  274.         MACRO
  275.         _CreateEditionContainerFile
  276.         MOVE.W     #$050E,D0
  277.         _Pack11
  278.         ENDM
  279.     
  280.     
  281. ;    FUNCTION DeleteEditionContainerFile(editionFile: FSSpec): OSErr;
  282.         MACRO
  283.         _DeleteEditionContainerFile
  284.         MOVE.W     #$0210,D0
  285.         _Pack11
  286.         ENDM
  287.     
  288.         
  289.     
  290. ;    FUNCTION OpenEdition(subscriberSectionH: SectionHandle; 
  291. ;                            VAR refNum: EditionRefNum): OSErr;
  292.         MACRO
  293.         _OpenEdition
  294.         MOVE.W     #$0412,D0
  295.         _Pack11
  296.         ENDM
  297.     
  298.     
  299. ;    FUNCTION OpenNewEdition(publisherSectionH: SectionHandle; fdCreator: OSType;
  300. ;                            publisherSectionDocument: FSSpecPtr;
  301. ;                            VAR refNum: EditionRefNum): OSErr;
  302.         MACRO
  303.         _OpenNewEdition
  304.         MOVE.W     #$0814,D0
  305.         _Pack11
  306.         ENDM
  307.     
  308.     
  309. ;    FUNCTION CloseEdition(whichEdition: EditionRefNum; successful: BOOLEAN): OSErr;
  310.         MACRO
  311.         _CloseEdition
  312.         MOVE.W     #$0316,D0
  313.         _Pack11
  314.         ENDM
  315.  
  316.  
  317. ;    FUNCTION EditionHasFormat(whichEdition: EditionRefNum; whichFormat: FormatType;
  318. ;                                VAR formatSize: Size): OSErr;
  319.         MACRO
  320.         _EditionHasFormat
  321.         MOVE.W     #$0618,D0
  322.         _Pack11
  323.         ENDM
  324.     
  325.     
  326. ;    FUNCTION ReadEdition(whichEdition: EditionRefNum; whichFormat: FormatType;
  327. ;                            buffPtr: Ptr; VAR buffLen: Size): OSErr;
  328.         MACRO
  329.         _ReadEdition
  330.         MOVE.W     #$081A,D0
  331.         _Pack11
  332.         ENDM
  333.     
  334.     
  335. ;    FUNCTION WriteEdition(whichEdition: EditionRefNum; whichFormat: FormatType;
  336. ;                            buffPtr: Ptr; buffLen: Size): OSErr;
  337.         MACRO
  338.         _WriteEdition
  339.         MOVE.W     #$081C,D0
  340.         _Pack11
  341.         ENDM
  342.     
  343.     
  344. ;    FUNCTION GetEditionFormatMark(whichEdition: EditionRefNum; whichFormat: FormatType;
  345. ;                                VAR currentMark: LONGINT): OSErr;
  346.         MACRO
  347.         _GetEditionFormatMark
  348.         MOVE.W     #$061E,D0
  349.         _Pack11
  350.         ENDM
  351.     
  352.     
  353. ;    FUNCTION SetEditionFormatMark(whichEdition: EditionRefNum; whichFormat: FormatType;
  354. ;                                setMarkTo: LONGINT): OSErr;
  355.         MACRO
  356.         _SetEditionFormatMark
  357.         MOVE.W     #$0620,D0
  358.         _Pack11
  359.         ENDM
  360.  
  361.  
  362.  
  363. ;    FUNCTION GetEditionInfo(sectionH: SectionHandle; VAR editionInfo: EditionInfoRecord): OSErr;
  364.         MACRO
  365.         _GetEditionInfo
  366.         MOVE.W     #$0422,D0
  367.         _Pack11
  368.         ENDM
  369.         
  370.         
  371. ;    FUNCTION GoToPublisherSection(container: EditionContainerSpec): OSErr;
  372.         MACRO
  373.         _GoToPublisherSection
  374.         MOVE.W     #$0224,D0
  375.         _Pack11
  376.         ENDM
  377.     
  378.     
  379. ;    FUNCTION GetLastEditionContainerUsed(VAR container: EditionContainerSpec): OSErr;    
  380.         MACRO
  381.         _GetLastEditionContainerUsed
  382.         MOVE.W     #$0226,D0
  383.         _Pack11
  384.         ENDM
  385.         
  386.         
  387. ;    FUNCTION GetStandardFormats(container: EditionContainerSpec; VAR previewFormat: FormatType;
  388. ;                                    preview, publisherAlias, formats: Handle): OSErr;
  389.         MACRO
  390.         _GetStandardFormats
  391.         MOVE.W     #$0A28,D0
  392.         _Pack11
  393.         ENDM
  394.     
  395.  
  396. ;    FUNCTION GetEditionOpenerProc(VAR opener: EditionOpenerProcPtr): OSErr;
  397.         MACRO
  398.         _GetEditionOpenerProc
  399.         MOVE.W     #$022A,D0
  400.         _Pack11
  401.         ENDM
  402.         
  403.  
  404. ;    FUNCTION SetEditionOpenerProc(opener: EditionOpenerProcPtr): OSErr;
  405.         MACRO
  406.         _SetEditionOpenerProc
  407.         MOVE.W     #$022C,D0
  408.         _Pack11
  409.         ENDM
  410.  
  411.  
  412. ;    FUNCTION CallEditionOpenerProc(selector: EditionOpenerVerb; VAR PB: EditionOpenerParamBlock;
  413. ;                            routine: EditionOpenerProcPtr): OSErr;
  414.         MACRO
  415.         _CallEditionOpenerProc
  416.         MOVE.W     #$052E,D0
  417.         _Pack11
  418.         ENDM
  419.  
  420.  
  421. ;    FUNCTION CallFormatIOProc(selector: FormatIOVerb; VAR PB: FormatIOParamBlock;
  422. ;                            routine: FormatIOProcPtr): OSErr;
  423.         MACRO
  424.         _CallFormatIOProc
  425.         MOVE.W     #$0530,D0
  426.         _Pack11
  427.         ENDM
  428.             
  429.  
  430.  
  431.  
  432. ;    FUNCTION NewSubscriberDialog(VAR reply: NewSubscriberReply): OSErr;
  433.         MACRO
  434.         _NewSubscriberDialog
  435.         MOVE.W     #$0232,D0
  436.         _Pack11
  437.         ENDM
  438.     
  439.     
  440. ;    FUNCTION NewSubscriberExpDialog(VAR reply: NewSubscriberReply; where: Point;
  441. ;                                    expansionDITLresID: INTEGER; dlgHook: ExpDlgHookProcPtr;
  442. ;                                    filterProc: ExpModalFilterProcPtr; yourDataPtr: UNIV Ptr): OSErr;
  443.         MACRO
  444.         _NewSubscriberExpDialog
  445.         MOVE.W     #$0B34,D0
  446.         _Pack11
  447.         ENDM
  448.     
  449.     
  450. ;    FUNCTION NewPublisherDialog(VAR reply: NewPublisherReply): OSErr;
  451.         MACRO
  452.         _NewPublisherDialog
  453.         MOVE.W     #$0236,D0
  454.         _Pack11
  455.         ENDM
  456.     
  457.     
  458. ;    FUNCTION NewPublisherExpDialog(VAR reply: NewPublisherReply; where: Point;
  459. ;                                    expansionDITLresID: INTEGER; dlgHook: ExpDlgHookProcPtr;
  460. ;                                    filterProc: ExpModalFilterProcPtr; yourDataPtr: UNIV Ptr): OSErr;
  461.         MACRO
  462.         _NewPublisherExpDialog
  463.         MOVE.W     #$0B38,D0
  464.         _Pack11
  465.         ENDM
  466.     
  467.     
  468. ;    FUNCTION SectionOptionsDialog(VAR reply: SectionOptionsReply): OSErr;
  469.         MACRO
  470.         _SectionOptionsDialog
  471.         MOVE.W     #$023A,D0
  472.         _Pack11
  473.         ENDM
  474.     
  475.     
  476. ;    FUNCTION SectionOptionsExpDialog(VAR reply: SectionOptionsReply; where: Point;
  477. ;                                    expansionDITLresID: INTEGER; dlgHook: ExpDlgHookProcPtr;
  478. ;                                    filterProc: ExpModalFilterProcPtr; yourDataPtr: UNIV Ptr): OSErr;
  479.         MACRO
  480.         _SectionOptionsExpDialog
  481.         MOVE.W     #$0B3C,D0
  482.         _Pack11
  483.         ENDM
  484.         
  485.  
  486.  
  487.     ENDIF    ; ...already included